<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>MiXiM: TrafficGen Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>


</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">MiXiM
   &#160;<span id="projectnumber">2.3</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('a00217.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="#pri-methods">Private Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">TrafficGen Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="TrafficGen" --><!-- doxytag: inherits="BaseApplLayer" -->
<p>A module to generate a certain rate of traffic.  
 <a href="a00217.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00418_source.html">TrafficGen.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for TrafficGen:</div>
<div class="dyncontent">
<div class="center"><img src="a01051.png" border="0" usemap="#TrafficGen_inherit__map" alt="Inheritance graph"/></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for TrafficGen:</div>
<div class="dyncontent">
<div class="center"><img src="a01052.png" border="0" usemap="#TrafficGen_coll__map" alt="Collaboration graph"/></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="a01053.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00217.html#ab3f33e4bfe1ef6044b6938b9dd054ca6">TrafficGenMessageKinds</a> { <a class="el" href="a00217.html#ab3f33e4bfe1ef6044b6938b9dd054ca6a291762a575ed780bda8ff5fd21e5e4a1">SEND_PACKET_TIMER</a> =  LAST_BASE_APPL_MESSAGE_KIND, 
<a class="el" href="a00217.html#ab3f33e4bfe1ef6044b6938b9dd054ca6a7c99b102d9593dbb193c4dafd1db4c44">TRAFFIC_GEN_PACKET</a>, 
<a class="el" href="a00217.html#ab3f33e4bfe1ef6044b6938b9dd054ca6affa00b6e47f4ffa2c67aa02f43c97e76">LAST_TRAFFIC_GEN_MESSAGE_KIND</a>
 }</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The message kinds used by this layer.  <a href="a00217.html#ab3f33e4bfe1ef6044b6938b9dd054ca6">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a083fea2270d41c26495fbc8e2bbe95be"></a><!-- doxytag: member="TrafficGen::initialize" ref="a083fea2270d41c26495fbc8e2bbe95be" args="(int stage)" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00217.html#a083fea2270d41c26495fbc8e2bbe95be">initialize</a> (int stage)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Omnet++ Initialisation. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a531800f6be75c55afc5d1ff86429079f"></a><!-- doxytag: member="TrafficGen::finish" ref="a531800f6be75c55afc5d1ff86429079f" args="()" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00217.html#a531800f6be75c55afc5d1ff86429079f">finish</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Called at the end of the simulation to record statistics. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa9406396f3f5cd85b5779889c56241c5"></a><!-- doxytag: member="TrafficGen::handleSelfMsg" ref="aa9406396f3f5cd85b5779889c56241c5" args="(cMessage *msg)" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00217.html#aa9406396f3f5cd85b5779889c56241c5">handleSelfMsg</a> (cMessage *msg)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handle self messages such as timer... <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a754b9f07a0644691d9c532c8aa2d374d"></a><!-- doxytag: member="TrafficGen::handleLowerMsg" ref="a754b9f07a0644691d9c532c8aa2d374d" args="(cMessage *msg)" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00217.html#a754b9f07a0644691d9c532c8aa2d374d">handleLowerMsg</a> (cMessage *msg)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handle messages from lower layer. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a246eb89973ae5af45a3c7ee7279e9777"></a><!-- doxytag: member="TrafficGen::sendBroadcast" ref="a246eb89973ae5af45a3c7ee7279e9777" args="()" -->
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00217.html#a246eb89973ae5af45a3c7ee7279e9777">sendBroadcast</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a broadcast message to lower layer. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aec31a7a067a59a61e01363ebfeacc747"></a><!-- doxytag: member="TrafficGen::packetTime" ref="aec31a7a067a59a61e01363ebfeacc747" args="" -->
simtime_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00217.html#aec31a7a067a59a61e01363ebfeacc747">packetTime</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The time it takes to transmit a packet. Bit length divided by bitrate. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4fb86caeca4afa1688fc5807b4f048c4"></a><!-- doxytag: member="TrafficGen::pppt" ref="a4fb86caeca4afa1688fc5807b4f048c4" args="" -->
double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00217.html#a4fb86caeca4afa1688fc5807b4f048c4">pppt</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Packets per packet time. More or less the load this layer should generate. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a084ddaeaac78f6e97f8319918a01100e"></a><!-- doxytag: member="TrafficGen::burstSize" ref="a084ddaeaac78f6e97f8319918a01100e" args="" -->
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00217.html#a084ddaeaac78f6e97f8319918a01100e">burstSize</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of packets to send at once. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad764b6f5e6766c650f6c2e4a6632be07"></a><!-- doxytag: member="TrafficGen::remainingBurst" ref="ad764b6f5e6766c650f6c2e4a6632be07" args="" -->
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00217.html#ad764b6f5e6766c650f6c2e4a6632be07">remainingBurst</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The remainign apckets to send for the current burst. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afc3659efb18c042a3808dc77cd401737"></a><!-- doxytag: member="TrafficGen::nbPacketDropped" ref="afc3659efb18c042a3808dc77cd401737" args="" -->
long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00217.html#afc3659efb18c042a3808dc77cd401737">nbPacketDropped</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Tracks the number of packets dropped so far. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a03134090b954c1b2578f148d89cf2ec6"></a><!-- doxytag: member="TrafficGen::delayTimer" ref="a03134090b954c1b2578f148d89cf2ec6" args="" -->
cMessage *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00217.html#a03134090b954c1b2578f148d89cf2ec6">delayTimer</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Timer message to schedule next packet send. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5074266ab490574d116cdad31f603483"></a><!-- doxytag: member="TrafficGen::world" ref="a5074266ab490574d116cdad31f603483" args="" -->
<a class="el" href="a00030.html">BaseWorldUtility</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00217.html#a5074266ab490574d116cdad31f603483">world</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to world utility module. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a47956bbb8359bc80347b9faec70526b3"></a><!-- doxytag: member="TrafficGen::TrafficGen" ref="a47956bbb8359bc80347b9faec70526b3" args="(const TrafficGen &amp;)" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00217.html#a47956bbb8359bc80347b9faec70526b3">TrafficGen</a> (const <a class="el" href="a00217.html">TrafficGen</a> &amp;)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor is not allowed. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6a7478d55f2a76e3046b11d84f3b2d32"></a><!-- doxytag: member="TrafficGen::operator=" ref="a6a7478d55f2a76e3046b11d84f3b2d32" args="(const TrafficGen &amp;)" -->
<a class="el" href="a00217.html">TrafficGen</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00217.html#a6a7478d55f2a76e3046b11d84f3b2d32">operator=</a> (const <a class="el" href="a00217.html">TrafficGen</a> &amp;)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator is not allowed. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A module to generate a certain rate of traffic. </p>
</div><hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="ab3f33e4bfe1ef6044b6938b9dd054ca6"></a><!-- doxytag: member="TrafficGen::TrafficGenMessageKinds" ref="ab3f33e4bfe1ef6044b6938b9dd054ca6" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="a00217.html#ab3f33e4bfe1ef6044b6938b9dd054ca6">TrafficGen::TrafficGenMessageKinds</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The message kinds used by this layer. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ab3f33e4bfe1ef6044b6938b9dd054ca6a291762a575ed780bda8ff5fd21e5e4a1"></a><!-- doxytag: member="SEND_PACKET_TIMER" ref="ab3f33e4bfe1ef6044b6938b9dd054ca6a291762a575ed780bda8ff5fd21e5e4a1" args="" -->SEND_PACKET_TIMER</em>&nbsp;</td><td>
<p>Schedules sending of a new message. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ab3f33e4bfe1ef6044b6938b9dd054ca6a7c99b102d9593dbb193c4dafd1db4c44"></a><!-- doxytag: member="TRAFFIC_GEN_PACKET" ref="ab3f33e4bfe1ef6044b6938b9dd054ca6a7c99b102d9593dbb193c4dafd1db4c44" args="" -->TRAFFIC_GEN_PACKET</em>&nbsp;</td><td>
<p>The kind for a packet send by this layer. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ab3f33e4bfe1ef6044b6938b9dd054ca6affa00b6e47f4ffa2c67aa02f43c97e76"></a><!-- doxytag: member="LAST_TRAFFIC_GEN_MESSAGE_KIND" ref="ab3f33e4bfe1ef6044b6938b9dd054ca6affa00b6e47f4ffa2c67aa02f43c97e76" args="" -->LAST_TRAFFIC_GEN_MESSAGE_KIND</em>&nbsp;</td><td>
<p>Sub classing layers shoudl begin their own kinds at this value. </p>
</td></tr>
</table>
</dd>
</dl>
<div class="fragment"><pre class="fragment">                              {
    <a class="code" href="a00217.html#ab3f33e4bfe1ef6044b6938b9dd054ca6a291762a575ed780bda8ff5fd21e5e4a1" title="Schedules sending of a new message.">SEND_PACKET_TIMER</a> = <a class="code" href="a00016.html#ae0d47602558bc21ad258c06cf11f4361a366d211a4409475c5bc2a1193033d8b3">LAST_BASE_APPL_MESSAGE_KIND</a>,
    <a class="code" href="a00217.html#ab3f33e4bfe1ef6044b6938b9dd054ca6a7c99b102d9593dbb193c4dafd1db4c44" title="The kind for a packet send by this layer.">TRAFFIC_GEN_PACKET</a>,
    <a class="code" href="a00217.html#ab3f33e4bfe1ef6044b6938b9dd054ca6affa00b6e47f4ffa2c67aa02f43c97e76" title="Sub classing layers shoudl begin their own kinds at this value.">LAST_TRAFFIC_GEN_MESSAGE_KIND</a>
  };
</pre></div>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>D:/Projects/MiXiM/extsrc/mixim/src/modules/application/<a class="el" href="a00418_source.html">TrafficGen.h</a></li>
<li>D:/Projects/MiXiM/extsrc/mixim/src/modules/application/TrafficGen.cc</li>
</ul>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="a00217.html">TrafficGen</a>      </li>

    <li class="footer">Generated on Tue Mar 5 2013 21:26:33 for MiXiM by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
   </ul>
 </div>


</body>
</html>
